/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007-2008 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.projects.toolbox_basics_project.bean.model;

import com.genia.toolbox.persistence.criteria.PropertyField;
import com.genia.toolbox.persistence.criteria.SimplePropertyField;

/**
 * Interface used to describe internationnalized value.
 */
public interface I18nValue
{

  /**
   * the name of the value property.
   */
  public static final SimplePropertyField<String> NAME_VALUE = PropertyField.create(String.class, "value");

  /**
   * the name of the escapedValue property.
   */
  public static final SimplePropertyField<String> NAME_ESCAPED_VALUE = PropertyField.create(String.class, "escapedValue");

  /**
   * the name of the languageInternal property.
   */
  public static final SimplePropertyField<Language> NAME_LANGUAGE = PropertyField.create(Language.class, "languageInternal");



  /**
   * getter for the value property.
   * 
   * @return the value property.
   */
  public String getValue();



  /**
   * setter for the value property.
   * 
   * @param value
   *          the value property.
   */
  public void setValue(final String value);



  /**
   * getter for the escapedValue property.
   * 
   * @return the escapedValue property.
   */
  public String getEscapedValue();



  /**
   * setter for the escapedValue property.
   * 
   * @param escapedValue
   *          the escapedValue property.
   */
  public void setEscapedValue(final String escapedValue);



  /**
   * getter for the language property.
   * 
   * @return the language property.
   */
  public Language getLanguage();



  /**
   * setter for the language property.
   * 
   * @param language
   *          the language property.
   */
  public void setLanguage(final Language language);
}
